{dialog.object}getListServerSideSummaryValue Method
Syntax
Arguments
- UXListName
The ID of the List control.
- field
The field to fetch the summary.
- summaryType
The type of summary to get. Can be one of the following values:
- Summary Type
- Description
- total
The total of all values
- count
The count of values
- avg
The average of values
- min
The minimum value
- max
The maximum value
Description
If the List definition specified that server-side summary values should be computed for any of the fields in the list, retrieves the summary value.
Discussion
The {dialog.object}.getListServerSideSummaryValue() method will fetch the summary value for a field. The list must be configured to compute summary values to use this method. You can configure the List to compute summary values using the Compute summary values server-side property.
The server-side summary value is the summary for all data in the current List query - not just the records that are currently shown in the List control. In the case of paginated Lists, the List query may have more records than are shown in the List.
To get a summary value, you must specify both the field and the summary value you want to get from the specified List. For example, the example below will get the 'total' for the 'QTY' columin in 'list1':
//get the 'total' for the 'QTY' column in 'list1'
var valueTot = {dialog.object}.getListServerSideSummaryValue('list1','QTY','total');Limitations
List Control Based on SQL Data Only
See Also